﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Home </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Home ">
    <meta name="generator" content="docfx 2.59.2.0">
    
    <link rel="shortcut icon" href="../../favicon.ico">
    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../styles/docfx.css">
    <link rel="stylesheet" href="../../styles/main.css">
    <link rel="stylesheet" href="../../styles/socialbar.css">
    <link rel="stylesheet" href="../../styles/header.css">
    <link rel="stylesheet" href="../../styles/version.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto:400,100,300,500,700,100italic,300italic,400italic" rel="stylesheet" type="text/css">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
    <meta property="docfx:navrel" content="../../toc.html">
    <meta property="docfx:tocrel" content="../toc.html">
    <meta property="docfx:uid" content="doc-restapi-Home">
    
    <meta property="docfx:rel" content="../../">
    
    <script type="text/javascript" src="../../nav.js"></script>
    <script type="text/javascript" src="../toc.js"></script>
  
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <div class="mb-socials-heading" style="height: 40px;">
        	<div class="mb-socials-heading-inner container">
        		<div class="mb-socials-heading-right">
        			<div class="mb-socials-list">
                          
        				<div class="mb-socials-item facebook">
        					<a class="mb-socials-item-link" target="_blank" href="https://facebook.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Facebook</span>
        					</div>
        				</div><div class="mb-socials-item twitter">
        					<a class="mb-socials-item-link" target="_blank" href="https://twitter.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Twitter</span>
        					</div>
        				</div>
        				<div class="mb-socials-item pinterest">
        					<a class="mb-socials-item-link" target="_blank" href="https://www.pinterest.com/emby0240/emby-news/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Pinterest</span>
        					</div>
        				</div>
        				<div class="mb-socials-item tumblr">
        					<a class="mb-socials-item-link" target="_blank" href="https://embyapp.tumblr.com/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Tumblr</span>
        					</div>
        				</div>
        				<div class="mb-socials-item github">
        					<a class="mb-socials-item-link" target="_blank" href="https://github.com/MediaBrowser"></a>
        					<div class="mb-socials-item-popup">
        						<span>GitHub</span>
        					</div>
        				</div><div class="mb-socials-item rss">
        					<a class="mb-socials-item-link" target="_blank" href="https://emby.media/blog.xml"></a>
        					<div class="mb-socials-item-popup">
        						<span>RSS</span>
        					</div>
        				</div>
                          
        			</div>
        		</div>
        	</div>
        </div>
        <div class="container">
        	<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
        		  
        		  <a class="navbar-brand" href="../../index.html">
        		    <img id="logo" class="svg" src="../../images/emby_dev_logo.png" alt="">
        		  </a>
        		  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
        			<span class="sr-only">Toggle navigation</span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        		  </button>
        		<div class="collapse navbar-collapse" id="navbar">
        			
        			<ul class="nav level1 navbar-nav">
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../index.html" title="DEV Home">DEV Home</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../doc/index.html" title="Documentation">Documentation</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../reference/index.html" title="Reference">Reference</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../download/index.html" title="Download">Download</a>
        			      </li>
        			</ul>		</div>
        	</nav>
        </div>
        <div class="nav-overlay d-none"></div>        
        <div class="subnav navbar navbar-default">
          <div class="container">
            <div class="hide-when-search" id="breadcrumb">
        	  <ul class="breadcrumb">
        		<li></li>
        	  </ul>
        	</div>
        
        	<div class="breadcrumpsearch">
        	  <form class="navbar-form navbar-right" role="search" id="search">
        		<div class="form-group">
        		  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
        		</div>
        	  </form>
        	</div>
          </div>
        </div>
      </header>
      <div class="container body-content">
        
        <div id="search-results">
          <div class="search-list">Search Results for <span></span></div>
          <div class="sr-items">
            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
          </div>
          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
        </div>
      </div>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="doc-restapi-Home">
<h1 id="rest-api-documentation">REST API Documentation</h1>

<h2 id="accessing-the-api">Accessing the API</h2>
<p>The Emby Server API can be reached via:</p>
<pre><code class="lang-restApi">http[s]://hostname:port/emby/{apipath}
</code></pre>
<h2 id="request-and-respose-types">Request and Respose Types</h2>
<p>The Emby Server API supports both JSON and XML formatted http requests and responses.
The format type can be controller via the http <em>&quot;Content-Type&quot;</em> header.
Appropriate values are</p>
<ul>
<li><em>&quot;application/json&quot;</em> or</li>
<li><em>&quot;application/xml&quot;</em></li>
</ul>
<h2 id="authentication">Authentication</h2>
<p>There are two different ways to authenticate with Emby Server:</p>
<ul>
<li><p><strong><a href="User-Authentication.html">User Authentication</a></strong><br>
With user authentication, you can log in to Emby Server by transmitting a username and a password.<br>
Typical use of this method is the development of client applications that will be interactively operated by an Emby user.<br></p>
</li>
<li><p><strong><a href="API-Key-Authentication.html">API Key Authentication</a></strong><br>
This authentication method allows accessing the Emby Server API by using a static token.
Authentication via API key is the right choice for integration scenarios with other applications, servers or services that are not tied to a certain user's context.</p>
</li>
</ul>
<h2 id="emby-api-browser">Emby API Browser</h2>
<p>Our developer wiki should be your first stop for information about developing with Emby server and is primarily aimed at getting your started.
For all the details about operations that can be performed, their parameters, request and return types, you need to visit the <strong>Emby API Browser</strong>.</p>
<p>Depending on whether you have access to a running Emby server or not, you can choose between two variants.</p>
<ul>
<li><p><a href="http://swagger.emby.media/?staticview=true"><strong>Emby API Browser (Static Version)</strong></a><br>
Explore the Emby API when you don't have access to a running Emby server.<br>
Allows browsing through all details but without interaction.<br></p>
</li>
<li><p><strong>Emby API Browser (Interactive Tryout)</strong><br>
With this variant you can not only view all API definitions - you will also be able to interactively perform calls against the API and view the results.<br>
This variant must be launched from the Server Dashboard of a running Emby Server installation.</p>
</li>
</ul>
<h5 id="launching-the-interactive-api-browser">Launching the Interactive API Browser</h5>
<p>To launch the interactive version of the API Browser please follow these steps:</p>
<ul>
<li>You need to have access to a running installation of Emby Server as an administrator</li>
<li>Open the Server Dashboard<br>
This is the web UI where you have performed all configuration of Emby Server<br></li>
<li>On the main dashboard page scroll down to the bottom of the right area<br>
(you hit the right page when the URL is ending with <em>'.../web/dashboard.html'</em>)</li>
<li>On the bottom you will see a number of links</li>
<li>Click on <strong>Api</strong>, and the API Browser will open in a new window.</li>
</ul>
<p><img src="../../images/emby_apibrowserlink_marked.jpg" alt=""></p>
<h2 id="api-client-libraries">API Client Libraries</h2>
<p>The Emby SDK includes a number of API clients in various programming languages:</p>
<ul>
<li><a href="../../home/sdk/apiclients/index.html">REST API Clients</a>
Sample implementations with source codes for C#, Java, JavaScript, Python and other languaes</li>
</ul>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <div class="sdkversion Release">
                  SDK <span class="sdkVersionSpan"></span>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>On this Page</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to Top</a>
            </span>
            Copyright 2022 © EMBY LLC.  Please see our <a class="lnk" href="https://emby.media/terms.html">terms of use</a> and <a class="lnk" href="https://emby.media/privacy.html">privacy policy</a>.
            
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../searchIndex.js"></script>
    <script type="text/javascript" src="../../styles/lunr.min.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>
